doc: make socket IPC examples more robust #13196
Merged
+13
−3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
child_process
santigimeno
approved these changes
May 24, 2017
doc/api/child_process.md
Outdated
| @@ -1136,7 +1136,7 @@ const normal = require('child_process').fork('child.js', ['normal']); | |||
| const special = require('child_process').fork('child.js', ['special']); | |||
|
|
|||
| // Open up the server and send sockets to child | |||
| const server = require('net').createServer(); | |||
| const server = require('net').createServer({ pauseOnConnect: true }); | |||
There was a problem hiding this comment.
Maybe a note why using pauseOnConnect: true is a good practice.
refack
approved these changes
May 24, 2017
lpinca
reviewed
May 24, 2017
doc/api/child_process.md
Outdated
| @@ -1166,6 +1171,10 @@ tracking when the socket is destroyed. To indicate this, the `.connections` | |||
| property becomes `null`. It is recommended not to use `.maxConnections` when | |||
| this occurs. | |||
|
|
|||
| It is also recommended that that any `'message'` handlers in the | |||
There was a problem hiding this comment.
Nit: is that repeated on purpose?
3 tasks
|
@cjihrig This would need a rebase :) |
|
Rebased and addressed comments. |
refack
approved these changes
Jun 22, 2017
This commit aims to improve the documentation examples that send sockets over IPC channels. Specifically, pauseOnConnect is added to a server that inspects the socket before sending and a 'message' handler adds a check that the socket still exists. PR-URL: nodejs#13196 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>
Merged
addaleax
pushed a commit
that referenced
this pull request
Jun 24, 2017
This commit aims to improve the documentation examples that send sockets over IPC channels. Specifically, pauseOnConnect is added to a server that inspects the socket before sending and a 'message' handler adds a check that the socket still exists. PR-URL: #13196 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>
Merged
|
Is this applicable to v6.x? |
|
ping @cjihrig |
|
Yes, I'd say it's applicable. |
|
@cjihrig do you have time to backport? |
4 tasks
|
Backport in #15482 |
MylesBorins
pushed a commit
that referenced
this pull request
Oct 16, 2017
This commit aims to improve the documentation examples that send sockets over IPC channels. Specifically, pauseOnConnect is added to a server that inspects the socket before sending and a 'message' handler adds a check that the socket still exists. PR-URL: #13196 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Oct 25, 2017
This commit aims to improve the documentation examples that send sockets over IPC channels. Specifically, pauseOnConnect is added to a server that inspects the socket before sending and a 'message' handler adds a check that the socket still exists. PR-URL: #13196 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>
Merged
abhishekumar-tyagi
pushed a commit
to abhishekumar-tyagi/node
that referenced
this pull request
May 5, 2024
This commit aims to improve the documentation examples that send sockets over IPC channels. Specifically, pauseOnConnect is added to a server that inspects the socket before sending and a 'message' handler adds a check that the socket still exists. PR-URL: nodejs/node#13196 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit aims to improve the documentation examples that send sockets over IPC channels. Specifically,
pauseOnConnectis added to a server that inspects the socket before sending and a'message'handler adds a check that the socket still exists.Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc
R= @santigimeno